Skip to main content

2.8.4. Response

FieldDescriptionType
statussuccess | error
codeError codeInteger
shiftIDExchange code  (only for checkout)
shiftOpenAtShift opening time, format yyyy - MM - dd hh:mmString
cashAmount of cash on handInteger
saleCountNumber of sales receiptsInteger
saleSumAmount of salesInteger
saleCashSumCash sales amountInteger
saleCashlessSumNet sales amountInteger
saleCreditSumAmount of sales creditInteger
saleBonusSumSum sales bonusesInteger
saleVatAmounts:[{…}]Number of cash depositsArrray
depositCountTotal amount of deposits per shift in kopecksInteger
depositSumTotal amount of deposits per shift in kopecksInteger
withdrawCountNumber of collectionsInteger
withdrawSumTotal amount of collections per shift in kopecksInteger
moneyBackCountNumber of checks returnedInteger
moneyBackSumReturn amountInteger
moneyBackCashSumCash refund amountInteger
moneyBackCashlessSumCashless refund amountInteger
moneyBackCreditSumAmount of credit returnsInteger
moneyBackBonusSumAmount of bonus returnsInteger
moneyBackVatAmounts[{…}]Arrray

saleVatAmounts {…} Array​

FieldDescriptionType
vatPercentPercent taxInteger
vatAmountSum tax in kopecksInteger

moneyBackVatAmounts {…} Array​

FieldDescriptionType
vatPercentTax percentageInteger
vatAmountTax amount in kopecksInteger

Error codes​

FieldDescription
0No error
1Authorization error
2Invalid JSON format
6Shift not found (by the specified code or there is no open shift in case no code)
7Payment type is not supported (there is no cash payment at the checkout)

Response example:​

{
"cash": 9100,
"cashRest": 7800,
"corrBonusesSum": 0,
"corrCashSum": 0,
"corrCashlessSum": 0,
"corrCount": 0,
"corrCreditSum": 0,
"corrPrepaymentSum": 0,
"corrSum": 0,
"corrVatAmounts": [],
"creditpayBonusesSum": 0,
"creditpayCashSum": 0,
"creditpayCashlessSum": 0,
"creditpayCount": 0,
"creditpayCreditSum": 0,
"creditpayPrepaymentSum": 0,
"creditpayRollbackBonusesSum": 0,
"creditpayRollbackCashSum": 0,
"creditpayRollbackCashlessSum": 0,
"creditpayRollbackCount": 0,
"creditpayRollbackCreditSum": 0,
"creditpayRollbackPrepaymentSum": 0,
"creditpayRollbackSum": 0,
"creditpaySum": 0,
"creditpayVatAmounts": [],
"departmentName": "",
"depositCount": 0,
"depositSum": 0,
"docCountToSend": 0,
"employeeName": null,
"firstDocNumber": "",
"lastDocNumber": "",
"moneyBackBonusesSum": 0,
"moneyBackCashSum": 0,
"moneyBackCashlessSum": 0,
"moneyBackCount": 0,
"moneyBackCreditSum": 0,
"moneyBackPrepaymentSum": 0,
"moneyBackSum": 0,
"moneyBackVatAmounts": [],
"openOrdersCnt": 0,
"prepayBonusesSum": 0,
"prepayCashSum": 0,
"prepayCashlessSum": 0,
"prepayCount": 0,
"prepayCreditSum": 0,
"prepayPrepaymentSum": 0,
"prepaySum": 0,
"prepayVatAmounts": [],
"reportNumber": "",
"rollbackBonusesSum": 0,
"rollbackCashSum": 0,
"rollbackCashlessSum": 0,
"rollbackCount": 0,
"rollbackCreditSum": 0,
"rollbackPrepaymentSum": 0,
"rollbackSum": 0,
"rollbackVatAmounts": [],
"saleBonusesSum": 0,
"saleCashSum": 1300,
"saleCashlessSum": 692,
"saleCount": 2,
"saleCreditSum": 0,
"salePrepaymentCashSum": 0,
"salePrepaymentCashlessSum": 21000,
"salePrepaymentSum": 21000,
"saleSum": 22992,
"saleVatAmounts": [
{
"calcSum": 1992,
"calcType": 1,
"fullName": "TVA 20%",
"originSum": 22992,
"taxCode": "A",
"taxType": 0,
"vatAmount": 332,
"vatName": "TVA",
"vatPercent": 2000,
"vatSum": 22992
}
],
"shiftID": 9,
"shiftOpenAt": "",
"status": "success",
"toPrint": 1,
"withdrawCount": 0,
"withdrawSum": 0,
"wsName": ""
}